electronic.alchemy :: An Introduction to Monger

Topics
photos
biographics
letterpress
pike
hyperlinks, etc
projects
contact info

sourcehut: hg
sourcehut: git

GotPike?

Recently Changed

Recent Albums
rephotograph
Monotype molds
Baltimore 2015
Europe 2014
Christmas Markets 2014

Interesting People
James
JZ
Deff
Bertrand

pike > Monger User

An Introduction to Monger

Created by hww3. Last updated by hww3, 9 years ago. Version #1.

One of the exciting new features available in Pike 7.6 is the addition of Monger. Monger is a tool designed to ease module management for Pike installations. By accessing data stored in a Pike Module Repository, Monger provides access to official and third party modules in real time. The current version of Monger provides 3 modes: List, Query and Install. We'll discuss each mode in turn below.

General Information

Monger is available as part of all Pike 7.6 installations. Currently, Monger is a command line utility, and can be accessed using the following command:

     pike -x monger

By default, monger will query the module repository at modules.gotpike.org:8000, however you can change the repository by providing it on the command line:

     pike -x monger --repository=host:port

List Mode

List mode allows you to see a list of the modules in the repository, optionally limited by a substring.

     pike -x monger --list [subphrase]

By running the list command without any additional arguments, you will get a list of all modules in the repository. If you wish to see modules in the repository whose name contains a given string, you can provide it after the list command. For example:

     pike -x monger --list Public

This command will provide a list of all modules in the repository whose name contains the phrase "Public".

Query Mode

Query mode allows you to view detailed information about a particular module in the repository. The query will include information about recommended versions of the module for your Pike installation.

For example:

     pike -x monger --query Public.Protocols.Jabber
     Selecting recommended version 1.0 for query.
     Public.Protocols.Jabber: This module provides a client interface to Jabber 
        Instant Messaging (IM) servers.
     Author/Owner: Bill Welliver
     Version: 1.0 (recommended)      License: GPL/LGPL/MPL
     Changes: Initial Release of the Jabber Client module
     This version supports plaintext authentication, presence, roster 
     management and send/receive messaging in an asynchronous environment 
     using callbacks. Connection using SSL is supported though largely 
     untested.

     This module is available for automated installation.

Use the version ~~option to view a particular version, and~~ force to force viewing of a particular version when it is not a recommended version (ie has a Pike dependency that is not satisfied by your version of Pike:

     pike -x monger --query --version=1.1 System.PAM
     Requested version 1.1 is not the recommended version.
     use --force to force query of this version.

Install Mode

One of the most useful features of Monger is its Install mode. Install mode is similar in many ways to the install command available in Perl's CPAN module. This mode allows you to automate the potentially tedious job of installing a module from source.

In order to use monger to install modules automatically, you must have the following in your PATH:

gzip
tar
make
the c compiler you used to compile pike; usually gcc

Monger will retrieve query the module repository for the best version of the module you want, download, build and finally install it. After a successful install, Monger will clean up after itself. If the build fails, Monger will leave the files it downloaded in case you wish to try to build the module manually.

pike -x monger --install IP.v4
Selecting recommended version 0.2 for install.
beginning download of version 0.2...
wrote module to file IP_v4-0.2.tar.gz (15786 bytes)
uncompressing...IP_v4-0.2.tar.gz
working with tar file IP_v4-0.2.tar
IP_v4-0.2/
IP_v4-0.2/CVS/
IP_v4-0.2/CVS/Entries
IP_v4-0.2/CVS/Repository
IP_v4-0.2/CVS/Root
IP_v4-0.2/CVS/Template
IP_v4-0.2/module.pmod.in/
IP_v4-0.2/module.pmod.in/Address.pike
IP_v4-0.2/module.pmod.in/Prefix.pike
IP_v4-0.2/module.pmod.in/Protocol.pike
IP_v4-0.2/module.pmod.in/Tuple.pike
IP_v4-0.2/module.pmod.in/helpers.pike
IP_v4-0.2/module.pmod.in/module.pmod
IP_v4-0.2/configure.in
IP_v4-0.2/Makefile.in
IP_v4-0.2/configure
IP_v4-0.2/testsuite.in
 make PIKE_INCLUDES=-I/usr/local/pike/7.6.25/include/pike PIKE_SRC_DIR=/usr/local/pike/7.6.25/include/pike BUILD_BASE=/usr/local/pike/7.6.25/include/pike MODULE_BASE=/usr/local/pike/7.6.25/include/pike TMP_BINDIR=/usr/local/pike/7.6.25/include/pike SRCDIR=. FULL_SRCDIR=/home/bertrand/.monger/IP_v4-0.2/ TMP_MODULE_BASE=. PIKE_EXTERNAL_MODULE=pike_external_module CORE_AUTODOC_PATH=/usr/local/pike/7.6.25/doc/src/core_autodoc.xml SYSTEM_DOC_PATH=/usr/local/pike/7.6.25/doc/ SYSTEM_MODULE_PATH=/usr/local/pike/7.6.25/lib/modules LOCAL_MODULE_PATH=$$HOME/lib/pike/modules RUNPIKE=pike all
cd . && /usr/local/pike/7.6.25/include/pike/run_autoconfig .
Running autoconf in .
AR="" CFLAGS="-g -Wa,--execstack -mcpu=i686" LDFLAGS="-L/usr/local/src/pike-7.6.25/src/bundles/lib -z execstack -R/usr/local/lib -L/usr/local/lib -R/usr/X11R6/lib -L/usr/X11R6/lib" LDSHARED="gcc -shared  " CPPFLAGS="-I/usr/local/src/pike-7.6.25/src/bundles/include -I/usr/local/include -I/usr/X11R6/include" BUILDDIR="" BINDIR="/usr/local/pike/7.6.25/include/pike" PIKE_SRC_DIR="/usr/local/pike/7.6.25/include/pike" BUILD_BASE="/usr/local/pike/7.6.25/include/pike" ./config.status --recheck
running /bin/sh ./configure  cache-file=./config.cache --with-cdebug --without-bundles CFLAGS=-g -Wa,execstack -mcpu=i686 CPPFLAGS=-I/usr/local/src/pike-7.6.25/src/bundles/include -I/usr/local/include -I/usr/X11R6/include LDFLAGS=-L/usr/local/src/pike-7.6.25/src/bundles/lib -z execstack -R/usr/local/lib -L/usr/local/lib -R/usr/X11R6/lib -L/usr/X11R6/lib  --no-create --no-recursion
configure: loading cache ./config.cache
###################################################
## Configuring module: IP_v4-0.2
## Installation dir:   

checking for C compiler default output file name… a.out
checking whether the C compiler works… yes
checking whether we are cross compiling… no
checking for suffix of executables… 
checking for suffix of object files... (cached) o
checking whether we are using the GNU C compiler… (cached) yes
checking whether /usr/local/pike/7.6.25/include/pike/smartlink gcc accepts -g… (cached) yes
checking for /usr/local/pike/7.6.25/include/pike/smartlink gcc option to accept ANSI C… (cached) none needed
checking if we are using TCC (TenDRA C Compiler)… (cached) no
checking how to run the C preprocessor… (cached) gcc -E
checking whether make sets $(MAKE)… (cached) yes
checking for the Pike base directory… /usr/local/pike/7.6.25/include/pike
configure: creating ./config.status
CONFIG_FILES="make_variables:/usr/local/pike/7.6.25/include/pike/make_variables.in" CONFIG_HEADERS="" ./config.status
config.status: creating make_variables
CONFIG_FILES=Makefile CONFIG_HEADERS="" ./config.status
config.status: creating Makefile
touch remake
Run make again
make: *** [Makefile] Error 1
 make PIKE_INCLUDES=-I/usr/local/pike/7.6.25/include/pike PIKE_SRC_DIR=/usr/local/pike/7.6.25/include/pike BUILD_BASE=/usr/local/pike/7.6.25/include/pike MODULE_BASE=/usr/local/pike/7.6.25/include/pike TMP_BINDIR=/usr/local/pike/7.6.25/include/pike SRCDIR=. FULL_SRCDIR=/home/bertrand/.monger/IP_v4-0.2/ TMP_MODULE_BASE=. PIKE_EXTERNAL_MODULE=pike_external_module CORE_AUTODOC_PATH=/usr/local/pike/7.6.25/doc/src/core_autodoc.xml SYSTEM_DOC_PATH=/usr/local/pike/7.6.25/doc/ SYSTEM_MODULE_PATH=/usr/local/pike/7.6.25/lib/modules LOCAL_MODULE_PATH=$$HOME/lib/pike/modules RUNPIKE=pike all
Making module.pmod
make all successful.
 make PIKE_INCLUDES=-I/usr/local/pike/7.6.25/include/pike PIKE_SRC_DIR=/usr/local/pike/7.6.25/include/pike BUILD_BASE=/usr/local/pike/7.6.25/include/pike MODULE_BASE=/usr/local/pike/7.6.25/include/pike TMP_BINDIR=/usr/local/pike/7.6.25/include/pike SRCDIR=. FULL_SRCDIR=/home/bertrand/.monger/IP_v4-0.2/ TMP_MODULE_BASE=. PIKE_EXTERNAL_MODULE=pike_external_module CORE_AUTODOC_PATH=/usr/local/pike/7.6.25/doc/src/core_autodoc.xml SYSTEM_DOC_PATH=/usr/local/pike/7.6.25/doc/ SYSTEM_MODULE_PATH=/usr/local/pike/7.6.25/lib/modules LOCAL_MODULE_PATH=$$HOME/lib/pike/modules RUNPIKE=pike verify
make[1]: Entering directory `/home/bertrand/.monger/IP_v4-0.2'
if test ! -d "./plib/modules" ; then &#13;
  mkdir -p ./plib/modules ; &#13;
fi; if test "x" != "x" ; then &#13;
  /usr/local/pike/7.6.25/include/pike/install_module module.so ./plib/modules/IP.pmod/_v4.so ;&#13;
fi; &#13;
if test "xmodule.pmod.in" != "x"; then &#13;
  /usr/local/pike/7.6.25/include/pike/install_module module.pmod ./plib/modules/IP.pmod/v4.pmod ;&#13;
fi
make[1]: Leaving directory `/home/bertrand/.monger/IP_v4-0.2'
pike -Mplib/modules /usr/local/pike/7.6.25/include/pike/test_pike.pike testsuite
Doing tests in testsuite (0 tests)
Total tests: 0  (0 tests skipped)       
make verify successful.
 make PIKE_INCLUDES=-I/usr/local/pike/7.6.25/include/pike PIKE_SRC_DIR=/usr/local/pike/7.6.25/include/pike BUILD_BASE=/usr/local/pike/7.6.25/include/pike MODULE_BASE=/usr/local/pike/7.6.25/include/pike TMP_BINDIR=/usr/local/pike/7.6.25/include/pike SRCDIR=. FULL_SRCDIR=/home/bertrand/.monger/IP_v4-0.2/ TMP_MODULE_BASE=. PIKE_EXTERNAL_MODULE=pike_external_module CORE_AUTODOC_PATH=/usr/local/pike/7.6.25/doc/src/core_autodoc.xml SYSTEM_DOC_PATH=/usr/local/pike/7.6.25/doc/ SYSTEM_MODULE_PATH=/usr/local/pike/7.6.25/lib/modules LOCAL_MODULE_PATH=$$HOME/lib/pike/modules RUNPIKE=pike install
make install successful.
cleaning up IP_v4-0.2.tar
removing directory IP_v4-0.2

The module IP.v4 is now installed:

pike
Pike v7.6 release 25 running Hilfe v3.5 (Incremental Pike Frontend)
> indices(IP.v4);
(1) Result: ({ /* 8 elements */
                "_ _author",
                "module",
                "helpers",
                "Tuple",
                "Prefix",
                "_ _version",
                "Protocol",
                "Address"
            })

Note that monger (and the underlying build process) will use whatever compiler settings were used when the pike software was built. If you need to change them (for instance if you install a library in a new location), you will need to edit the specs file in the /path/to/pike/include/pike directory. Be careful when editing this file, as you can easily break the build process. Always make a backup copy of the specs file.

Developer Tools

Recent versions of Monger provide tools for manipulating the module repository programmatically. This allows (for example) new module versions to be added to the repository from within a release creation script. Details for this functionality can be found in the Monger Developer documentation.

Drawbacks

While Monger is a very useful tool, it does have a few shortcomings. Hopefully, these will be addressed in subsequent releases of Pike.

Monger requires an active connection to the internet during operation.
Retrieved module distributions and data are not cached on the local client.
Data is not verified for authenticity using checksums.
Documentation is not automatically generated.
There is no interactive mode.
Settings are not currently saved.

Not categorized | RSS Feed | BackLinks